MarkLogic 12 Product Documentation
GET /manage/v2/databases/{id|name}/alert/configs/properties

Summary

This resource address returns the configuration properties of the alert specified by the mandatory uri parameter from the specified database.

URL Parameters
uri The URI of the alert. This parameter is required.
format The format of the posted data. Can be either json or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the request body. If the format? parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested data. If the payload is malformed, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

id

uri

name

description

triggers

The triggers for an alert configuration.

This is a complex structure with the following children:

trigger

domains

The cpf domains for an alert configuration.

This is a complex structure with the following children:

domain

options

This is a complex structure with the following children:

option

actions

This is a complex structure with the following children:

action

Example


curl -X GET  --anyauth -u admin:admin --header "Content-Type:application/json" \
http://localhost:8002/manage/v2/databases/Documents/alert/configs/properties?uri=my-alert-config

==>  Returns the properties of the "my-alert-config" alert for the Documents
     database.
Powered by MarkLogic Server | Terms of Use | Privacy Policy